<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />
	<meta name="robots" content="noindex" />

	<title>File Mandrill/Ips.php</title>

	<script type="text/javascript" src="resources/combined.js?394153670"></script>
	<script type="text/javascript" src="elementlist.js?882160656"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Namespaces</h3>
			<ul>
				<li class="active"><a href="namespace-None.html">None</a>
						</li>
				<li><a href="namespace-PHP.html">PHP</a>
						</li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Mandrill.html">Mandrill</a></li>
				<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
				<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
				<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
				<li class="active"><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
				<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
				<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
				<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
				<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
				<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
				<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
				<li><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
				<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
				<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
				<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
				<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
			</ul>



			<h3>Exceptions</h3>
			<ul>
				<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
				<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
				<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
				<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
				<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
				<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
				<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
				<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
				<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
				<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
				<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
				<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
				<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
				<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
				<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
				<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
				<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
				<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
				<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
				<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
				<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
				<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
				<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
				<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
				<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
				<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
				<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
				<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
				<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
				<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
				<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
			</li>
			<li>
				<a href="class-Mandrill_Ips.html" title="Summary of Mandrill_Ips"><span>Class</span></a>
			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<pre><code><span id="1" class="l"><a class="l" href="#1">  1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2">  2: </a>
</span><span id="3" class="l"><a class="l" href="#3">  3: </a><span class="php-keyword1">class</span> <a id="Mandrill_Ips" href="#Mandrill_Ips">Mandrill_Ips</a> {
</span><span id="4" class="l"><a class="l" href="#4">  4: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(Mandrill <span class="php-var">$master</span>) {
</span><span id="5" class="l"><a class="l" href="#5">  5: </a>        <span class="php-var">$this</span>-&gt;master = <span class="php-var">$master</span>;
</span><span id="6" class="l"><a class="l" href="#6">  6: </a>    }
</span><span id="7" class="l"><a class="l" href="#7">  7: </a>
</span><span id="8" class="l"><a class="l" href="#8">  8: </a>    <span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9">  9: </a><span class="php-comment">     * Lists your dedicated IPs.
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment">     * @return array an array of structs for each dedicated IP
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment">     *     - return[] struct information about a single dedicated IP
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment">     *         - ip string the ip address
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment">     *         - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment">     *         - pool string the name of the pool that this dedicated IP belongs to
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment">     *         - domain string the domain name (reverse dns) of this dedicated IP
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment">     *         - custom_dns struct information about the ip's custom dns, if it has been configured
</span></span><span id="17" class="l"><a class="l" href="#17"> 17: </a><span class="php-comment">     *             - enabled boolean a boolean indicating whether custom dns has been configured for this ip
</span></span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-comment">     *             - valid boolean whether the ip's custom dns is currently valid
</span></span><span id="19" class="l"><a class="l" href="#19"> 19: </a><span class="php-comment">     *             - error string if the ip's custom dns is invalid, this will include details about the error
</span></span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-comment">     *         - warmup struct information about the ip's warmup status
</span></span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-comment">     *             - warming_up boolean whether the ip is currently in warmup mode
</span></span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-comment">     *             - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-comment">     *             - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-comment">     */</span>
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getList" href="#_getList">getList</a>() {
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/list'</span>, <span class="php-var">$_params</span>);
</span><span id="28" class="l"><a class="l" href="#28"> 28: </a>    }
</span><span id="29" class="l"><a class="l" href="#29"> 29: </a>
</span><span id="30" class="l"><a class="l" href="#30"> 30: </a>    <span class="php-comment">/**
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment">     * Retrieves information about a single dedicated ip.
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment">     * @param string $ip a dedicated IP address
</span></span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-comment">     * @return struct Information about the dedicated ip
</span></span><span id="34" class="l"><a class="l" href="#34"> 34: </a><span class="php-comment">     *     - ip string the ip address
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
</span></span><span id="38" class="l"><a class="l" href="#38"> 38: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
</span></span><span id="40" class="l"><a class="l" href="#40"> 40: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
</span></span><span id="43" class="l"><a class="l" href="#43"> 43: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment">     */</span>
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_info" href="#_info">info</a>(<span class="php-var">$ip</span>) {
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>);
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/info'</span>, <span class="php-var">$_params</span>);
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a>    }
</span><span id="51" class="l"><a class="l" href="#51"> 51: </a>
</span><span id="52" class="l"><a class="l" href="#52"> 52: </a>    <span class="php-comment">/**
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment">     * Requests an additional dedicated IP for your account. Accounts may
</span></span><span id="54" class="l"><a class="l" href="#54"> 54: </a><span class="php-comment">have one outstanding request at any time, and provisioning requests
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment">are processed within 24 hours.
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment">     * @param boolean $warmup whether to enable warmup mode for the ip
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment">     * @param string $pool the id of the pool to add the dedicated ip to, or null to use your account's default pool
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment">     * @return struct a description of the provisioning request that was created
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment">     *     - requested_at string the date and time that the request was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
</span></span><span id="60" class="l"><a class="l" href="#60"> 60: </a><span class="php-comment">     */</span>
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_provision" href="#_provision">provision</a>(<span class="php-var">$warmup</span>=<span class="php-keyword1">false</span>, <span class="php-var">$pool</span>=<span class="php-keyword1">null</span>) {
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;warmup&quot;</span> =&gt; <span class="php-var">$warmup</span>, <span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>);
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/provision'</span>, <span class="php-var">$_params</span>);
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a>    }
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a>    <span class="php-comment">/**
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment">     * Begins the warmup process for a dedicated IP. During the warmup process,
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment">Mandrill will gradually increase the percentage of your mail that is sent over
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment">the warming-up IP, over a period of roughly 30 days. The rest of your mail
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment">will be sent over shared IPs or other dedicated IPs in the same pool.
</span></span><span id="71" class="l"><a class="l" href="#71"> 71: </a><span class="php-comment">     * @param string $ip a dedicated ip address
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment">     * @return struct Information about the dedicated IP
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment">     *     - ip string the ip address
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="75" class="l"><a class="l" href="#75"> 75: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
</span></span><span id="76" class="l"><a class="l" href="#76"> 76: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
</span></span><span id="77" class="l"><a class="l" href="#77"> 77: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
</span></span><span id="78" class="l"><a class="l" href="#78"> 78: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
</span></span><span id="79" class="l"><a class="l" href="#79"> 79: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
</span></span><span id="82" class="l"><a class="l" href="#82"> 82: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
</span></span><span id="83" class="l"><a class="l" href="#83"> 83: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="84" class="l"><a class="l" href="#84"> 84: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="85" class="l"><a class="l" href="#85"> 85: </a><span class="php-comment">     */</span>
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_startWarmup" href="#_startWarmup">startWarmup</a>(<span class="php-var">$ip</span>) {
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>);
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/start-warmup'</span>, <span class="php-var">$_params</span>);
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a>    }
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a>
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a>    <span class="php-comment">/**
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment">     * Cancels the warmup process for a dedicated IP.
</span></span><span id="93" class="l"><a class="l" href="#93"> 93: </a><span class="php-comment">     * @param string $ip a dedicated ip address
</span></span><span id="94" class="l"><a class="l" href="#94"> 94: </a><span class="php-comment">     * @return struct Information about the dedicated IP
</span></span><span id="95" class="l"><a class="l" href="#95"> 95: </a><span class="php-comment">     *     - ip string the ip address
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="106" class="l"><a class="l" href="#106">106: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="107" class="l"><a class="l" href="#107">107: </a><span class="php-comment">     */</span>
</span><span id="108" class="l"><a class="l" href="#108">108: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_cancelWarmup" href="#_cancelWarmup">cancelWarmup</a>(<span class="php-var">$ip</span>) {
</span><span id="109" class="l"><a class="l" href="#109">109: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>);
</span><span id="110" class="l"><a class="l" href="#110">110: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/cancel-warmup'</span>, <span class="php-var">$_params</span>);
</span><span id="111" class="l"><a class="l" href="#111">111: </a>    }
</span><span id="112" class="l"><a class="l" href="#112">112: </a>
</span><span id="113" class="l"><a class="l" href="#113">113: </a>    <span class="php-comment">/**
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment">     * Moves a dedicated IP to a different pool.
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment">     * @param string $ip a dedicated ip address
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment">     * @param string $pool the name of the new pool to add the dedicated ip to
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment">     * @param boolean $create_pool whether to create the pool if it does not exist; if false and the pool does not exist, an Unknown_Pool will be thrown.
</span></span><span id="118" class="l"><a class="l" href="#118">118: </a><span class="php-comment">     * @return struct Information about the updated state of the dedicated IP
</span></span><span id="119" class="l"><a class="l" href="#119">119: </a><span class="php-comment">     *     - ip string the ip address
</span></span><span id="120" class="l"><a class="l" href="#120">120: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="121" class="l"><a class="l" href="#121">121: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
</span></span><span id="122" class="l"><a class="l" href="#122">122: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
</span></span><span id="123" class="l"><a class="l" href="#123">123: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
</span></span><span id="124" class="l"><a class="l" href="#124">124: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
</span></span><span id="125" class="l"><a class="l" href="#125">125: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
</span></span><span id="126" class="l"><a class="l" href="#126">126: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
</span></span><span id="127" class="l"><a class="l" href="#127">127: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
</span></span><span id="128" class="l"><a class="l" href="#128">128: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
</span></span><span id="129" class="l"><a class="l" href="#129">129: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="130" class="l"><a class="l" href="#130">130: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="131" class="l"><a class="l" href="#131">131: </a><span class="php-comment">     */</span>
</span><span id="132" class="l"><a class="l" href="#132">132: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setPool" href="#_setPool">setPool</a>(<span class="php-var">$ip</span>, <span class="php-var">$pool</span>, <span class="php-var">$create_pool</span>=<span class="php-keyword1">false</span>) {
</span><span id="133" class="l"><a class="l" href="#133">133: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>, <span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>, <span class="php-quote">&quot;create_pool&quot;</span> =&gt; <span class="php-var">$create_pool</span>);
</span><span id="134" class="l"><a class="l" href="#134">134: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/set-pool'</span>, <span class="php-var">$_params</span>);
</span><span id="135" class="l"><a class="l" href="#135">135: </a>    }
</span><span id="136" class="l"><a class="l" href="#136">136: </a>
</span><span id="137" class="l"><a class="l" href="#137">137: </a>    <span class="php-comment">/**
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment">     * Deletes a dedicated IP. This is permanent and cannot be undone.
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment">     * @param string $ip the dedicated ip to remove from your account
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment">     * @return struct a description of the ip that was removed from your account.
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment">     *     - ip string the ip address
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment">     *     - deleted string a boolean indicating whether the ip was successfully deleted
</span></span><span id="143" class="l"><a class="l" href="#143">143: </a><span class="php-comment">     */</span>
</span><span id="144" class="l"><a class="l" href="#144">144: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$ip</span>) {
</span><span id="145" class="l"><a class="l" href="#145">145: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>);
</span><span id="146" class="l"><a class="l" href="#146">146: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/delete'</span>, <span class="php-var">$_params</span>);
</span><span id="147" class="l"><a class="l" href="#147">147: </a>    }
</span><span id="148" class="l"><a class="l" href="#148">148: </a>
</span><span id="149" class="l"><a class="l" href="#149">149: </a>    <span class="php-comment">/**
</span></span><span id="150" class="l"><a class="l" href="#150">150: </a><span class="php-comment">     * Lists your dedicated IP pools.
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment">     * @return array the dedicated IP pools for your account, up to a maximum of 1,000
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment">     *     - return[] struct information about each dedicated IP pool
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment">     *         - name string this pool's name
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment">     *         - created_at string the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment">     *         - ips array the dedicated IPs in this pool
</span></span><span id="156" class="l"><a class="l" href="#156">156: </a><span class="php-comment">     *             - ips[] struct information about each dedicated IP
</span></span><span id="157" class="l"><a class="l" href="#157">157: </a><span class="php-comment">     *                 - ip string the ip address
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment">     *                 - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment">     *                 - pool string the name of the pool that this dedicated IP belongs to
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment">     *                 - domain string the domain name (reverse dns) of this dedicated IP
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment">     *                 - custom_dns struct information about the ip's custom dns, if it has been configured
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment">     *                     - enabled boolean a boolean indicating whether custom dns has been configured for this ip
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment">     *                     - valid boolean whether the ip's custom dns is currently valid
</span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment">     *                     - error string if the ip's custom dns is invalid, this will include details about the error
</span></span><span id="165" class="l"><a class="l" href="#165">165: </a><span class="php-comment">     *                 - warmup struct information about the ip's warmup status
</span></span><span id="166" class="l"><a class="l" href="#166">166: </a><span class="php-comment">     *                     - warming_up boolean whether the ip is currently in warmup mode
</span></span><span id="167" class="l"><a class="l" href="#167">167: </a><span class="php-comment">     *                     - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment">     *                     - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment">     */</span>
</span><span id="170" class="l"><a class="l" href="#170">170: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_listPools" href="#_listPools">listPools</a>() {
</span><span id="171" class="l"><a class="l" href="#171">171: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>();
</span><span id="172" class="l"><a class="l" href="#172">172: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/list-pools'</span>, <span class="php-var">$_params</span>);
</span><span id="173" class="l"><a class="l" href="#173">173: </a>    }
</span><span id="174" class="l"><a class="l" href="#174">174: </a>
</span><span id="175" class="l"><a class="l" href="#175">175: </a>    <span class="php-comment">/**
</span></span><span id="176" class="l"><a class="l" href="#176">176: </a><span class="php-comment">     * Describes a single dedicated IP pool.
</span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment">     * @param string $pool a pool name
</span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment">     * @return struct Information about the dedicated ip pool
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment">     *     - name string this pool's name
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment">     *     - created_at string the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
</span></span><span id="181" class="l"><a class="l" href="#181">181: </a><span class="php-comment">     *     - ips array the dedicated IPs in this pool
</span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment">     *         - ips[] struct information about each dedicated IP
</span></span><span id="183" class="l"><a class="l" href="#183">183: </a><span class="php-comment">     *             - ip string the ip address
</span></span><span id="184" class="l"><a class="l" href="#184">184: </a><span class="php-comment">     *             - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="185" class="l"><a class="l" href="#185">185: </a><span class="php-comment">     *             - pool string the name of the pool that this dedicated IP belongs to
</span></span><span id="186" class="l"><a class="l" href="#186">186: </a><span class="php-comment">     *             - domain string the domain name (reverse dns) of this dedicated IP
</span></span><span id="187" class="l"><a class="l" href="#187">187: </a><span class="php-comment">     *             - custom_dns struct information about the ip's custom dns, if it has been configured
</span></span><span id="188" class="l"><a class="l" href="#188">188: </a><span class="php-comment">     *                 - enabled boolean a boolean indicating whether custom dns has been configured for this ip
</span></span><span id="189" class="l"><a class="l" href="#189">189: </a><span class="php-comment">     *                 - valid boolean whether the ip's custom dns is currently valid
</span></span><span id="190" class="l"><a class="l" href="#190">190: </a><span class="php-comment">     *                 - error string if the ip's custom dns is invalid, this will include details about the error
</span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment">     *             - warmup struct information about the ip's warmup status
</span></span><span id="192" class="l"><a class="l" href="#192">192: </a><span class="php-comment">     *                 - warming_up boolean whether the ip is currently in warmup mode
</span></span><span id="193" class="l"><a class="l" href="#193">193: </a><span class="php-comment">     *                 - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment">     *                 - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment">     */</span>
</span><span id="196" class="l"><a class="l" href="#196">196: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_poolInfo" href="#_poolInfo">poolInfo</a>(<span class="php-var">$pool</span>) {
</span><span id="197" class="l"><a class="l" href="#197">197: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>);
</span><span id="198" class="l"><a class="l" href="#198">198: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/pool-info'</span>, <span class="php-var">$_params</span>);
</span><span id="199" class="l"><a class="l" href="#199">199: </a>    }
</span><span id="200" class="l"><a class="l" href="#200">200: </a>
</span><span id="201" class="l"><a class="l" href="#201">201: </a>    <span class="php-comment">/**
</span></span><span id="202" class="l"><a class="l" href="#202">202: </a><span class="php-comment">     * Creates a pool and returns it. If a pool already exists with this
</span></span><span id="203" class="l"><a class="l" href="#203">203: </a><span class="php-comment">name, no action will be performed.
</span></span><span id="204" class="l"><a class="l" href="#204">204: </a><span class="php-comment">     * @param string $pool the name of a pool to create
</span></span><span id="205" class="l"><a class="l" href="#205">205: </a><span class="php-comment">     * @return struct Information about the dedicated ip pool
</span></span><span id="206" class="l"><a class="l" href="#206">206: </a><span class="php-comment">     *     - name string this pool's name
</span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment">     *     - created_at string the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
</span></span><span id="208" class="l"><a class="l" href="#208">208: </a><span class="php-comment">     *     - ips array the dedicated IPs in this pool
</span></span><span id="209" class="l"><a class="l" href="#209">209: </a><span class="php-comment">     *         - ips[] struct information about each dedicated IP
</span></span><span id="210" class="l"><a class="l" href="#210">210: </a><span class="php-comment">     *             - ip string the ip address
</span></span><span id="211" class="l"><a class="l" href="#211">211: </a><span class="php-comment">     *             - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="212" class="l"><a class="l" href="#212">212: </a><span class="php-comment">     *             - pool string the name of the pool that this dedicated IP belongs to
</span></span><span id="213" class="l"><a class="l" href="#213">213: </a><span class="php-comment">     *             - domain string the domain name (reverse dns) of this dedicated IP
</span></span><span id="214" class="l"><a class="l" href="#214">214: </a><span class="php-comment">     *             - custom_dns struct information about the ip's custom dns, if it has been configured
</span></span><span id="215" class="l"><a class="l" href="#215">215: </a><span class="php-comment">     *                 - enabled boolean a boolean indicating whether custom dns has been configured for this ip
</span></span><span id="216" class="l"><a class="l" href="#216">216: </a><span class="php-comment">     *                 - valid boolean whether the ip's custom dns is currently valid
</span></span><span id="217" class="l"><a class="l" href="#217">217: </a><span class="php-comment">     *                 - error string if the ip's custom dns is invalid, this will include details about the error
</span></span><span id="218" class="l"><a class="l" href="#218">218: </a><span class="php-comment">     *             - warmup struct information about the ip's warmup status
</span></span><span id="219" class="l"><a class="l" href="#219">219: </a><span class="php-comment">     *                 - warming_up boolean whether the ip is currently in warmup mode
</span></span><span id="220" class="l"><a class="l" href="#220">220: </a><span class="php-comment">     *                 - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="221" class="l"><a class="l" href="#221">221: </a><span class="php-comment">     *                 - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="222" class="l"><a class="l" href="#222">222: </a><span class="php-comment">     */</span>
</span><span id="223" class="l"><a class="l" href="#223">223: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_createPool" href="#_createPool">createPool</a>(<span class="php-var">$pool</span>) {
</span><span id="224" class="l"><a class="l" href="#224">224: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>);
</span><span id="225" class="l"><a class="l" href="#225">225: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/create-pool'</span>, <span class="php-var">$_params</span>);
</span><span id="226" class="l"><a class="l" href="#226">226: </a>    }
</span><span id="227" class="l"><a class="l" href="#227">227: </a>
</span><span id="228" class="l"><a class="l" href="#228">228: </a>    <span class="php-comment">/**
</span></span><span id="229" class="l"><a class="l" href="#229">229: </a><span class="php-comment">     * Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
</span></span><span id="230" class="l"><a class="l" href="#230">230: </a><span class="php-comment">     * @param string $pool the name of the pool to delete
</span></span><span id="231" class="l"><a class="l" href="#231">231: </a><span class="php-comment">     * @return struct information about the status of the pool that was deleted
</span></span><span id="232" class="l"><a class="l" href="#232">232: </a><span class="php-comment">     *     - pool string the name of the pool
</span></span><span id="233" class="l"><a class="l" href="#233">233: </a><span class="php-comment">     *     - deleted boolean whether the pool was deleted
</span></span><span id="234" class="l"><a class="l" href="#234">234: </a><span class="php-comment">     */</span>
</span><span id="235" class="l"><a class="l" href="#235">235: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deletePool" href="#_deletePool">deletePool</a>(<span class="php-var">$pool</span>) {
</span><span id="236" class="l"><a class="l" href="#236">236: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;pool&quot;</span> =&gt; <span class="php-var">$pool</span>);
</span><span id="237" class="l"><a class="l" href="#237">237: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/delete-pool'</span>, <span class="php-var">$_params</span>);
</span><span id="238" class="l"><a class="l" href="#238">238: </a>    }
</span><span id="239" class="l"><a class="l" href="#239">239: </a>
</span><span id="240" class="l"><a class="l" href="#240">240: </a>    <span class="php-comment">/**
</span></span><span id="241" class="l"><a class="l" href="#241">241: </a><span class="php-comment">     * Tests whether a domain name is valid for use as the custom reverse
</span></span><span id="242" class="l"><a class="l" href="#242">242: </a><span class="php-comment">DNS for a dedicated IP.
</span></span><span id="243" class="l"><a class="l" href="#243">243: </a><span class="php-comment">     * @param string $ip a dedicated ip address
</span></span><span id="244" class="l"><a class="l" href="#244">244: </a><span class="php-comment">     * @param string $domain the domain name to test
</span></span><span id="245" class="l"><a class="l" href="#245">245: </a><span class="php-comment">     * @return struct validation results for the domain
</span></span><span id="246" class="l"><a class="l" href="#246">246: </a><span class="php-comment">     *     - valid string whether the domain name has a correctly-configured A record pointing to the ip address
</span></span><span id="247" class="l"><a class="l" href="#247">247: </a><span class="php-comment">     *     - error string if valid is false, this will contain details about why the domain's A record is incorrect
</span></span><span id="248" class="l"><a class="l" href="#248">248: </a><span class="php-comment">     */</span>
</span><span id="249" class="l"><a class="l" href="#249">249: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_checkCustomDns" href="#_checkCustomDns">checkCustomDns</a>(<span class="php-var">$ip</span>, <span class="php-var">$domain</span>) {
</span><span id="250" class="l"><a class="l" href="#250">250: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>, <span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="251" class="l"><a class="l" href="#251">251: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/check-custom-dns'</span>, <span class="php-var">$_params</span>);
</span><span id="252" class="l"><a class="l" href="#252">252: </a>    }
</span><span id="253" class="l"><a class="l" href="#253">253: </a>
</span><span id="254" class="l"><a class="l" href="#254">254: </a>    <span class="php-comment">/**
</span></span><span id="255" class="l"><a class="l" href="#255">255: </a><span class="php-comment">     * Configures the custom DNS name for a dedicated IP.
</span></span><span id="256" class="l"><a class="l" href="#256">256: </a><span class="php-comment">     * @param string $ip a dedicated ip address
</span></span><span id="257" class="l"><a class="l" href="#257">257: </a><span class="php-comment">     * @param string $domain a domain name to set as the dedicated IP's custom dns name.
</span></span><span id="258" class="l"><a class="l" href="#258">258: </a><span class="php-comment">     * @return struct information about the dedicated IP's new configuration
</span></span><span id="259" class="l"><a class="l" href="#259">259: </a><span class="php-comment">     *     - ip string the ip address
</span></span><span id="260" class="l"><a class="l" href="#260">260: </a><span class="php-comment">     *     - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="261" class="l"><a class="l" href="#261">261: </a><span class="php-comment">     *     - pool string the name of the pool that this dedicated IP belongs to
</span></span><span id="262" class="l"><a class="l" href="#262">262: </a><span class="php-comment">     *     - domain string the domain name (reverse dns) of this dedicated IP
</span></span><span id="263" class="l"><a class="l" href="#263">263: </a><span class="php-comment">     *     - custom_dns struct information about the ip's custom dns, if it has been configured
</span></span><span id="264" class="l"><a class="l" href="#264">264: </a><span class="php-comment">     *         - enabled boolean a boolean indicating whether custom dns has been configured for this ip
</span></span><span id="265" class="l"><a class="l" href="#265">265: </a><span class="php-comment">     *         - valid boolean whether the ip's custom dns is currently valid
</span></span><span id="266" class="l"><a class="l" href="#266">266: </a><span class="php-comment">     *         - error string if the ip's custom dns is invalid, this will include details about the error
</span></span><span id="267" class="l"><a class="l" href="#267">267: </a><span class="php-comment">     *     - warmup struct information about the ip's warmup status
</span></span><span id="268" class="l"><a class="l" href="#268">268: </a><span class="php-comment">     *         - warming_up boolean whether the ip is currently in warmup mode
</span></span><span id="269" class="l"><a class="l" href="#269">269: </a><span class="php-comment">     *         - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="270" class="l"><a class="l" href="#270">270: </a><span class="php-comment">     *         - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
</span></span><span id="271" class="l"><a class="l" href="#271">271: </a><span class="php-comment">     */</span>
</span><span id="272" class="l"><a class="l" href="#272">272: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setCustomDns" href="#_setCustomDns">setCustomDns</a>(<span class="php-var">$ip</span>, <span class="php-var">$domain</span>) {
</span><span id="273" class="l"><a class="l" href="#273">273: </a>        <span class="php-var">$_params</span> = <span class="php-keyword1">array</span>(<span class="php-quote">&quot;ip&quot;</span> =&gt; <span class="php-var">$ip</span>, <span class="php-quote">&quot;domain&quot;</span> =&gt; <span class="php-var">$domain</span>);
</span><span id="274" class="l"><a class="l" href="#274">274: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;master-&gt;call(<span class="php-quote">'ips/set-custom-dns'</span>, <span class="php-var">$_params</span>);
</span><span id="275" class="l"><a class="l" href="#275">275: </a>    }
</span><span id="276" class="l"><a class="l" href="#276">276: </a>
</span><span id="277" class="l"><a class="l" href="#277">277: </a>}
</span><span id="278" class="l"><a class="l" href="#278">278: </a>
</span><span id="279" class="l"><a class="l" href="#279">279: </a>
</span><span id="280" class="l"><a class="l" href="#280">280: </a></span></code></pre>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
